/*
 * Copyright (c) 2018 Memorial Sloan-Kettering Cancer Center.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY, WITHOUT EVEN THE IMPLIED WARRANTY OF MERCHANTABILITY OR FITNESS
 * FOR A PARTICULAR PURPOSE. The software and documentation provided hereunder
 * is on an "as is" basis, and Memorial Sloan-Kettering Cancer Center has no
 * obligations to provide maintenance, support, updates, enhancements or
 * modifications. In no event shall Memorial Sloan-Kettering Cancer Center be
 * liable to any party for direct, indirect, special, incidental or
 * consequential damages, including lost profits, arising out of the use of this
 * software and its documentation, even if Memorial Sloan-Kettering Cancer
 * Center has been advised of the possibility of such damage.
 */

/*
 * This file is part of cBioPortal.
 *
 * cBioPortal is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.cbioportal.legacy.service;

import java.util.Date;
import java.util.List;
import org.cbioportal.legacy.model.DataAccessToken;
import org.springframework.security.core.Authentication;

public interface DataAccessTokenService {

  public DataAccessToken createDataAccessToken(String username);

  public List<DataAccessToken> getAllDataAccessTokens(String username);

  public DataAccessToken getDataAccessToken(String username);

  public DataAccessToken getDataAccessTokenInfo(String token);

  public void revokeAllDataAccessTokens(String username);

  public void revokeDataAccessToken(String token);

  public String getUsername(String token);

  public Date getExpiration(String token);

  public Authentication createAuthenticationRequest(String token);

  /**
   * Tests token validity. Token is valid if: - not yet expired and - not revoked and - can be
   * verified as issued through this service (maybe via signature)
   *
   * @param token
   * @return
   */
  public Boolean isValid(String token);
}
